PUT
/
v1
/
system
/
users
/
{type}
/
{id}
Update one User
curl --request PUT \
  --url https://{client_id}.shipstream.app/api/global/v1/system/users/{type}/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "OrganizationUser",
  "name": "Bernard Greensmith",
  "email": "admin@example.com",
  "username": "b.greensmith",
  "is_active": true,
  "roles": [
    {
      "type": "OrganizationUserRole",
      "id": 3
    }
  ],
  "login_via_badge": true,
  "default_warehouse": {
    "type": "Warehouse",
    "id": 123
  }
}'
This response does not have an example.

Path Parameters

​
type
enum<string>
required

Specify the user type to which your operations will be restricted.

Available options:
any,
organization,
client
​
id
integer
required

The id of the referenced User.

Required range: x >= 1

Body

application/json

An object conforming to the User schema to be merged with the existing User.

A user with organization-wide access.

Response

200

OK - The operation completed successfully and there is no response body.